Skip to content

doc(ud): correct link generation#15672

Merged
scotthart merged 3 commits intogoogleapis:mainfrom
scotthart:ud_dox_broken_links
Oct 31, 2025
Merged

doc(ud): correct link generation#15672
scotthart merged 3 commits intogoogleapis:mainfrom
scotthart:ud_dox_broken_links

Conversation

@scotthart
Copy link
Member

@scotthart scotthart commented Oct 31, 2025

Updates to the dox files to fix some broken links when rendered. Also removed some @c sequences that looked funny in the rendered dox files.

@scotthart scotthart requested review from a team October 31, 2025 14:15
@gemini-code-assist
Copy link

gemini-code-assist bot commented Oct 31, 2025

Summary of Changes

Hello @scotthart, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing the quality and readability of the Doxygen documentation for Google Cloud client libraries. It addresses widespread issues with incorrectly formatted links and extraneous @c sequences, ensuring that the generated documentation is accurate, well-formed, and easy to navigate for developers.

Highlights

  • Documentation Link Fixes: Corrected numerous broken links within the Doxygen documentation files across various Google Cloud client libraries.
  • Improved Documentation Rendering: Removed problematic @c sequences from Doxygen files that caused rendering issues, ensuring cleaner and more accurate documentation display.
  • Documentation Generation Template Update: Updated the internal code generation template (scaffold_generator.cc) to prevent future occurrences of these documentation formatting issues.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist[bot]
gemini-code-assist bot reviewed Oct 31, 2025
View reviewed changes
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request makes widespread changes to documentation files to fix rendering issues. The changes replace Doxygen @ref links with code formatting to prevent broken links, and remove @c formatting from page titles. The changes are consistent and look correct. I've only found a few minor copy-paste errors in page titles within google/cloud/pubsub/doc/pubsub-main.dox, for which I've provided suggestions.

@codecov
Copy link

codecov bot commented Oct 31, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.11%. Comparing base (d8c6aae) to head (7972f12).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #15672   +/-   ##
=======================================
  Coverage   93.10%   93.11%           
=======================================
  Files        2442     2442           
  Lines      224365   224365           
=======================================
+ Hits       208900   208907    +7     
+ Misses      15465    15458    -7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@scotthart scotthart enabled auto-merge (squash) October 31, 2025 15:02
@scotthart scotthart merged commit 8467cec into googleapis:main Oct 31, 2025
64 of 67 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mpeddada1 mpeddada1 mpeddada1 approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@scotthart @mpeddada1